Skip to content

docs(ai-chat): correct chat.agent reference drift#3892

Merged
ericallam merged 2 commits into
mainfrom
docs/chat-agent-accuracy
Jun 12, 2026
Merged

docs(ai-chat): correct chat.agent reference drift#3892
ericallam merged 2 commits into
mainfrom
docs/chat-agent-accuracy

Conversation

@ericallam

@ericallam ericallam commented Jun 10, 2026

Copy link
Copy Markdown
Member

Summary

Accuracy fixes across the AI chat docs: drop the non-existent per-call option from transport.preload, clarify that onValidateMessages only fires on turns carrying incoming messages, soften the turn-complete token-refresh wording (the header is optional), document the new onTurnComplete error field and finishReason, and correct the idle-timeout default to 30 seconds.

@ericallam
docs(ai-chat): correct chat.agent reference drift
5d114d0 
Fix transport.preload signature (no per-call idle option), clarify that
onValidateMessages only fires on turns carrying incoming messages, soften
the turn-complete token-refresh wording since the header is optional,
document the onTurnComplete error field and finishReason, and correct the
idle-timeout default to 30 seconds.
@changeset-bot

changeset-bot Bot commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 22c64cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: eee80cee-25df-4ad0-b57c-f4df956cc2c8

📥 Commits

Reviewing files that changed from the base of the PR and between 5d114d0 and 22c64cd.

📒 Files selected for processing (1)
  • docs/ai-chat/client-protocol.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/ai-chat/client-protocol.mdx
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Mintlify Deployment

Walkthrough

This PR updates documentation across five AI chat API guides to reflect current implementation behavior. Changes clarify that turn completion events include an error field for errored turns (with potentially undefined or partial response messages), the optional nature of token refresh headers, idempotency header generation per logical send with retry reuse, default idle timeout as 30 seconds, preload transport signature accepting only chatId without per-call timeout options, and hook execution conditions that skip validation on turns without incoming messages.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides a clear summary of all changes made, but does not follow the repository's required template structure with checklist, testing, and changelog sections. Add the required template sections including checklist confirmation, testing steps, and structured changelog entry to match the repository's pull request template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main objective: correcting documentation accuracy issues across the AI chat module regarding the chat.agent reference implementation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/chat-agent-accuracy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mintlify

mintlify Bot commented Jun 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trigger 🟢 Ready View Preview Jun 10, 2026, 2:50 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

coderabbitai[bot]

This comment was marked as resolved.

Sign in to view

@ericallam
docs(ai-chat): correct the X-Part-Id entropy note
22c64cd 
The built-in clients generate a high-entropy id per send (UUID in the
browser, full-length nanoid server-side), not a short id.
@ericallam ericallam marked this pull request as ready for review June 11, 2026 07:39
devin-ai-integration[bot]
devin-ai-integration Bot reviewed Jun 11, 2026
View reviewed changes

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 3 potential issues.

View 2 additional findings in Devin Review.

Open in Devin Review

Comment thread docs/ai-chat/reference.mdx
Comment thread docs/ai-chat/error-handling.mdx
Comment thread docs/ai-chat/error-handling.mdx
@ericallam ericallam merged commit 51af9ae into main Jun 12, 2026
30 of 32 checks passed
@ericallam ericallam deleted the docs/chat-agent-accuracy branch June 12, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@devin-ai-integration devin-ai-integration[bot] devin-ai-integration[bot] left review comments

@d-cs d-cs d-cs approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ericallam @d-cs